Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP - [Mouse Without Borders] - refactoring "Common" classes (Part 4) - #35155 #37579

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

WIP - [Mouse Without Borders] - refactoring "Common" classes (Part 4) - #35155 #37579

wants to merge 6 commits into from

Conversation

mikeclayton
Copy link
Contributor

Summary of the Pull Request

Part 4 of a slow-running refactor of the giant "Common" class in Mouse Without Borders into individual classes with tighter private scope.

  • Extract the "Common" code from the following files:
    • Common.Event.cs -> Event.cs
    • Common.Helper.cs -> Helper.cs
    • Common.Launch.cs -> Launch.cs
    • Common.Service.cs -> Service.cs
  • Update references to the types in the new locations
  • Update unit test to verify functionality has only changed in an expected way

PR Checklist

Detailed Description of the Pull Request / Additional comments

Validation Steps Performed

Run manual tests from Test Checklist Template:

  • Install PowerToys on two PCs in the same local network:

    • Verify that PowerToys is properly installed on both PCs.

  • Setup Connection:

    • Open MWB's settings on the first PC and click the "New Key" button. Verify that a new security key is generated.
    • Copy the generated security key and paste it in the corresponding input field in the settings of MWB on the second PC. Also enter the name of the first PC in the required field.
    • Press "Connect" and verify that the machine layout now includes two PC tiles, each displaying their respective PC names.

  • Verify Connection Status:

    • Ensure that the border of the remote PC turns green, indicating a successful connection.
    • Enter an incorrect security key and verify that the border of the remote PC turns red, indicating a failed connection.

  • Test Remote Mouse/Keyboard Control:

    • With the PCs connected, test the mouse/keyboard control from one PC to another. Verify that the mouse/keyboard inputs are correctly registered on the other PC.
    • Test remote mouse/keyboard control across all four PCs, if available. Verify that inputs are correctly registered on each connected PC when the mouse is active there.
      • unable to test - only 2 machines available

  • Test Remote Control with Elevated Apps:

    • note - the main PowerToys.exe must be running as a non-admin for these tests
    • Open an elevated app on one of the PCs. Verify that without "Use Service" enabled, PowerToys does not control the elevated app.
    • Enable "Use Service" in MWB's settings (need to run PowerToys.exe as admin to enable "Use Service", then restart PowerToys.exe as non-admin). Verify that PowerToys can now control the elevated app remotely. Verify that MWB processes are running as LocalSystem, while the MWB helper process is running non-elevated.
      • get-process -Name "PowerToys.MouseWithoutBorders*" -IncludeUserName | format-table Id, ProcessName, UserName
      • Process: PowerToys.MouseWithoutBorders.exe - running as SYSTEM
      • Process: PowerToys.MouseWithoutBorders.Helper.exe - running as current user
      • get-service -Name "PowerToys.*" | ft Status, Name, UserName; get-ciminstance -Class "Win32_Service" -Filter "Name like 'PowerToys%'" | ft ProcessId, Name
      • Service: PowerToys.MWB.Service - running as Local System
    • Toggle "Use Service" again, verify that each time you do that, the MWB processes are restarted.
    • Run PowerToys elevated on one of the machines, verify that you can control elevated apps remotely now on that machine.

  • Test Module Enable Status:

    • For all combinations of "Use Service"/"Run PowerToys as admin", try enabling/disabling MWB module and verify that it's indeed being toggled using task manager.

  • Test Disconnection/Reconnection:

    • Disconnect one of the PCs from network. Verify that the machine layout updates to reflect the disconnection.
    • Do the same, but now by exiting PowerToys.
    • Start PowerToys again, verify that the PCs are reconnected.

  • Test Various Local Network Conditions:

    • Test MWB performance under various network conditions (e.g., low bandwidth, high latency). Verify that the tool maintains a stable connection and functions correctly.

  • Clipboard Sharing:

    • Copy some text on one PC and verify that the same text can be pasted on another PC.
    • Use the screenshot key and Win+Shift+S to take a screenshot on one PC and verify that the screenshot can be pasted on another PC.
    • Copy a file in Windows Explorer and verify that the file can be pasted on another PC. Make sure the file size is below 100MB.
    • Try to copy multiple files and directories and verify that it's not possible (only the first selected file is being copied).

  • Drag and Drop:

    • Drag a file from Windows Explorer on one PC, cross the screen border onto another PC, and release it there. Verify that the file is copied to the other PC. Make sure the file size is below 100MB.
    • While dragging the file, verify that a corresponding icon is displayed under the mouse cursor.
    • Without moving the mouse from one PC to the target PC, press CTRL+ALT+F1/2/3/4 hotkey to switch to the target PC directly and verify that file sharing/dropping is not working.

  • Lock and Unlock with "Use Service" Enabled:

    • Enable "Use Service" in MWB's settings.
    • Lock a remote PC using Win+L, move the mouse to it remotely, and try to unlock it. Verify that you can unlock the remote PC.
    • Disable "Use Service" in MWB's settings, lock the remote PC, move the mouse to it remotely, and try to unlock it. Verify that you can't unlock the remote PC.

  • Test Settings:

    • Change the rest of available settings on MWB page and verify that each setting works as described.

Group Policy Tests

See https://learn.microsoft.com/en-us/windows/powertoys/grouppolicy

  • Install *.admx / *.adml and check settings behave as expected
    • I'll expand the list of settings here when I get this far :-)
  • HKEY_LOCAL_MACHINE\SOFTWARE\Policies\PowerToys
    • ConfigureEnabledUtilityMouseWithoutBorders
      • [missing] - "Activation -> Enable Mouse Without Borders" enabled, with GPO warning hidden
      • 0 - "Activation -> Enable Mouse Without Borders" set to "off" and disabled, with GPO warning visible
      • 1 - "Activation -> Enable Mouse Without Borders" set to "on" and disabled, with GPO warning visible
    • MwbClipboardSharingEnabled
    • MwbFileTransferEnabled
    • MwbUseOriginalUserInterface
    • MwbDisallowBlockingScreensaver
    • MwbSameSubnetOnly
    • MwbValidateRemoteIp
    • MwbDisableUserDefinedIpMappingRules
      • [missing] - "Advanced Settings -> IP address mapping" enabled, with GPO warning hidden
      • 0 - "Advanced Settings -> IP address mapping" enabled, with GPO warning hidden
      • 1 - "Advanced Settings -> IP address mapping" disabled, with GPO warning visible
    • MwbPolicyDefinedIpMappingRules
      • [missing] - "Advanced Settings -> IP address mapping" enabled, with GPO warning and GPO values hidden
      • [empty value] - "Advanced Settings -> IP address mapping" enabled, with GPO warning hidden and GPO values hidden
      • [non-empty value] - "Advanced Settings -> IP address mapping" enabled, with GPO warning visible and GPO values visible

@mikeclayton mikeclayton mentioned this pull request Feb 22, 2025
Open
Copilot
Copilot AI reviewed Feb 25, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 26 out of 26 changed files in this pull request and generated 1 comment.

src/modules/MouseWithoutBorders/App/Core/Service.cs
internal static void StartMouseWithoutBordersService(string desktopToRunMouseWithoutBordersOn = null, string startTag1 = "byapp", string startTag2 = null)
{
// NOTE(@yuyoyuppe): the new flow assumes we run both mwb processes directly from the svc.
if (Common.RunWithNoAdminRight || true)
Copy link
Preview

Copilot AI Feb 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The use of '|| true' in the conditional always evaluates to true, bypassing the intended service start logic. Consider removing '|| true' or revising the condition to properly control service startup.

Suggested change
if (Common.RunWithNoAdminRight || true)
if (Common.RunWithNoAdminRight)

Copilot is powered by AI, so mistakes are possible. Review output carefully before use.

Positive Feedback
Negative Feedback

Provide additional feedback

Please help us improve GitHub Copilot by sharing more details about this comment.

Please select one or more of the options
@jaimecbernardo
Copy link
Collaborator

Hi @mikeclayton ,
Thank you for opening this PR.
Is this ready for review yet? Looks like reviews are already being asked?

@mikeclayton
Copy link
Contributor Author

mikeclayton commented Feb 27, 2025 •
edited
Loading

@jaimecbernardo - I didn't request the review as I've not properly worked through the tests yet, but it compiles locally and superficially appears to work.

Happy to follow your lead though - I don't mind if you want to wait until I've finished testing before starting the review process. I already pushed one set of changes (#36950) into the next release (v0.89.0), so might be better to defer this PR until the release after to avoid too much churn?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@vanzue vanzue Awaiting requested review from vanzue

@drawbyperpetual drawbyperpetual Awaiting requested review from drawbyperpetual

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mikeclayton @jaimecbernardo